/*
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *    2010 year
 *    Author: Michael Khromov aka MikeDM (Mike D'Morto)
 *    E-Mail: mikedmorto@gmail.com
 */

#ifndef IFACE_DBPLUGIN_H
#define IFACE_DBPLUGIN_H
/*
 интерфейс плагина баз данных.
 */

#include <QtCore/QtPlugin>
#include <QtSql/QSqlQuery>



class TsIfaceDbPlugin : public QObject{

public:
    // деструктор, обязателен для виртуального класса.
    virtual ~TsIfaceDbPlugin(){};
    // инициализация плагина, первый метод который вызывается после загрузки плагина
    // ему передается строка конфиг плагина, служит для конфигуриования плагина.
    // пример: установка прав использования данного плагина для данного юзера. ну итп итд.
    // вобщем при желании и наличии фантазии автора плагина можно много чего достич.
    virtual bool qinit(const QStringList & cfgsrt)=0;
    // метод возвращающий имя плагина, служит для его идентификации.
    //virtual QString getPluginName()=0;
    // перечитать сприсок функций для плагинов. реализовать при необходимости.
    //virtual void refreshAq()=0;
public slots:
    // асинхронная работа с бд. все запросы идут в разнобой.
    // такой метод не повзоляет работать с транзакциями.
    // метод запроса в базу. возвращет значение, возможен ли запрос.
    // если труЪ то будет обрабатываться запрос
    // 1 параметр это имя плагина делающего запрос
    // 2 параметр собственно вызываемая функция
    // 3 шаг, внутренний идентификатор рабочих плагинов, плагин бд возвращает его же через сигнал.
    //      он является идентификатором проводимой операции.
    // 4 параметр список аргументов для этой функции
    virtual void slotQexec(const QString pl_name,const QString & fname,const QList<QVariant> & parameters)=0;
    virtual void slotClear(int id)=0;
    // режим синхронной работы, для транзакций.
    // первый запрос от плагина на начала синхронного режима.
    virtual void slotQstartS(const QString & pl_name)=0;
    // запрос в базу в асинхронном режиме
    virtual void slotQexecS(const QString pl_name,const QString & fname,const QList<QVariant> & parameters)=0;
    // сигнал окончания работы в синхронном режиме
    virtual void slotQstopS(const QString & pl_name)=0;
    // слот завершения работы с бд
    virtual void slotStop()=0;

signals:
    // сигналы для работы в асинхронном режиме
    // данный сигнал отдается после осуществления запроса
    // 1 параметр это кому предназначены данные, плагины сами разберутся.
    // 2 внутренний идентификатор рабочего плагина. см выше слот запроса.
    // 3 параметр это собственно сами данные, которые и будет парсить плагин.
    virtual void sigFinish(const QString & plName , int id, QSqlQuery * ret)=0;
    // сигнал сигнализирующий об ошибке запроса
    // 1 параметр, кому.
    // 2 параметр это номер внутреннего шага рабочего плагина
    // 3 параметр собственно ошибко.
    virtual void sigFinishErr(const QString & plName , const QString & errtext)=0;
    // сигнал для записи в лог.
    virtual void sigPutLog(const QString & owner,int level,const QString & text)=0;
    // сигналы для работы в синхронном режиме.
    // положительный ответ на запрос синхронного режима.
    virtual void sigRstartS(const QString pl_name)=0;
    // ответ положительный с данными по запросу.
    virtual void sigFinishS(const QString & plName , QSqlQuery * ret)=0;
    // ответ отрицательный с данными по ошибке
    virtual void sigFinishErrS(const QString & plName , const QString & errtext)=0;


private:

};

Q_DECLARE_INTERFACE(TsIfaceDbPlugin,"ru.torisakura.tsifacedbplugin/1.0")
#endif // IFACE_DBPLUGIN_H
